api/statuses/{id} (Get)

Get	api/statuses/{id}

In This Topic

Resource Path: /sites/{company-id}/api/statuses/{id}

Uri: https://secure.ontime360.com/sites/{company-id}/api/statuses/{id}

Description

Retrieves a single Status object assigned to a given identifier.

Parameters

Name	Description	Data Type
id	The unique identifier of a Status as a Guid.	string

200 Response

The response body is of type Status.

Returns a comprehensive Status object.

Overview

Status

Represents a comprehensive Status record within the OnTime API.

ID : string

The unique identifier for this Status record.

Name : string

The name assigned to this Status.

Description : string

The description containing any notable details or conditions regarding this Status.

Timestamp : string

The date and time this Status was applied to an Order.

Level : string

The level detailing the status of a given Order. Available Values: [None, Dispatched, AssignedInRoute, Delivered, Cancelled, CancelledBillable, Assigned, Stored, UnassignedStored, Quoted]

Fault Responses

Fault	Description
400	Request was improperly formatted, contained invalid data, or contained incorrect values. See response body for more information.
401	Authorization key is invalid or no longer exists.
403	Authorization key does not have permission to perform this action, or does not have permission to access the requested data. See response body for more information.